Gets the reference number of the specified desktop database. This function runs synchronously only.

OSErr PBDTGetPath (
    DTPBPtr paramBlock
);

paramBlock

A pointer to a desktop parameter block.

function result

A result code.

DISCUSSION

Clear all fields (other than input fields) in the parameter block that you pass to Desktop Manager functions. The relevant fields of the parameter block for this function are:

• ioResultOn return, the result code of the function. A value of type OSErr.
• ioNamePtrOn input, a pointer to the volume name or full pathname of the desktop database. A value of type StringPtr.
• ioVRefNameOn input, the volume reference number of the desktop database. A value of type SInt16.
• ioDTRefNumOn return, the desktop database reference number, which represents the access path to the database. A value of type SInt16. You cannot use the desktop reference number as a file reference number in any File Manager functions. If PBDTGetPath fails, it sets this field to 0.

You specify the volume by passing a pointer to its name in the ioNamePtr field or a volume reference number in the ioVRefNum field. If the desktop database is not already open, PBDTGetPath opens it and then returns the reference number. If the desktop database doesn’t exist, PBDTGetPath creates it .

SPECIAL CONSIDERATIONS

Do not call PBDTGetPath at interrupt time—it allocates memory in the system heap.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)